Get the transcript of a call

This endpoint retrieves the conversation flow of one call.

Endpoint

GET /api/v1/calls/{callId}/conversationFlow

Path parameters

Parameter	Type	Description
callId	string	UUID of the call.

Query parameters

Parameter	Type	Description
type	array	Optional. Which message types to include. Repeat the parameter once per type, as in ?type=dialog&type=metadata. Omit it and every type is included.

type takes these values:

Value	What it includes
dialog	Text spoken by both sides of the conversation.
system	System events, such as conversation start and call end.
control	Control events to and from the bot, such as configuration updates.
rawBot	Every event to and from the bot, in raw form.
metadata	Metadata events sent from the bot to the agent application, for agent assist.

Request

GET /api/v1/calls/82c6d362-d68b-4c6f-8136-1739323379e7/conversationFlow?type=dialog&type=metadata HTTP/1.1
Host: livehub.audiocodes.io
Authorization: Bearer {token}

Response

200 OK — a JSON object whose root is conversationFlow, an array of messages in chronological order. Each message carries a timestamp, a type, and an object named after that type holding the message itself.

{
  "conversationFlow": [
    {
      "timestamp": "2022-04-26T13:49:28.469Z",
      "type": "dialogMessage",
      "dialogMessage": {
        "message": "Welcome to the Pizza service. I will try to do my best with your pizza ordering. What would you like?",
        "side": "Bot",
        "selfGenerated": true,
        "ttsDelayMs": 2140
      }
    },
    {
      "timestamp": "2021-01-07T07:56:19.896Z",
      "type": "controlMessage",
      "controlMessage": {
        "message": "Activity type 'typing'",
        "side": "Bot",
        "botDelayMs": 49
      }
    }
  ]
}